Vcenter FoundationLoadBalancers IpAddressSpec

Vcenter FoundationLoadBalancers IpAddressSpec
Vcenter FoundationLoadBalancers IpAddressSpec

Vcenter FoundationLoadBalancers IpAddressSpec schema defines IP address configuration.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "type": "string",
    "ip_address": "string",
    "prefix": 0,
    "personas": [
        "string"
    ],
    "gateway": "string"
}
string
type
Required

IP address assignment method.

For more information see: Vcenter FoundationLoadBalancers IpAddressSpec Type.

This property was added in vSphere API 9.0.0.0.

string
ip_address
Optional

IP address assigned to the node.

This property was added in vSphere API 9.0.0.0.

The field is required when assigning a STATIC type of IP address and skipped when assigning a DHCP type of IP address. The field is automatically populated with currently requested DHCP IP address.

integer As int64 As int64
prefix
Optional

IP address prefix length.

This property was added in vSphere API 9.0.0.0.

The field is required when assigning a STATIC IP address and skipped when assigning a DHCP IP address.

array of string
personas
Optional

The network interface role, it can contain multiple roles used for different scenarios.

For more information see: Vcenter FoundationLoadBalancers IpAddressSpec Persona.

This property was added in vSphere API 9.0.0.0.

If missing or null, keep current configuration unset or unchanged.

string
gateway
Optional

The default gateway address of the load balancer node, address in CIDR format, e.g., 10.0.0.1/24.

This property was added in vSphere API 9.0.0.0.

If missing or null, the default gateway keeps unset or unchanged.

Property Of